Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: [FC-0074] add note about decisions documented in each hooks repositories #662

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: [FC-0074] add note about decisions documented in each hooks repositories #662

wants to merge 1 commit into from
+26 −0

Conversation

mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Jan 14, 2025 •
edited
Loading

Description

This PR adds notes about Open edX Events and Filters to event-driven-related OEPs and the Hooks Extension Framework OEP, specifying where to find architectural decisions about the framework. This PR addresses: openedx/openedx-events#438 (review)

@openedx-webhooks
Copy link

openedx-webhooks commented Jan 14, 2025 •
edited
Loading

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @sarina.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 14, 2025
@mariajgrimaldi mariajgrimaldi force-pushed the MJG/add-note-about-ADRs branch 2 times, most recently from 99934df to 9e16cf0 Compare January 14, 2025 12:54
@mariajgrimaldi mariajgrimaldi force-pushed the MJG/add-note-about-ADRs branch from 9e16cf0 to 8e1b831 Compare January 14, 2025 12:58
@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review January 14, 2025 13:00
@mariajgrimaldi mariajgrimaldi changed the title docs: add note about decisions documented in each hooks repositories docs: [FC-0074] add note about decisions documented in each hooks repositories Jan 14, 2025
@mariajgrimaldi mariajgrimaldi added the FC Relates to an Axim Funded Contribution project label Jan 14, 2025
@mariajgrimaldi mariajgrimaldi mentioned this pull request Jan 14, 2025
Merged
15 tasks
robrap
robrap reviewed Jan 14, 2025
View reviewed changes
Copy link
Contributor

@robrap robrap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some ideas to see what you both think.

oeps/architectural-decisions/oep-0041-arch-async-server-event-messaging.rst
@@ -475,10 +475,16 @@ Having a clearly defined set of events would allow for simpler third party
integration in areas like student learner event processing and course catalog
management.

------------

.. note:: All future decisions related to :doc:`Open edX Events <openedx-events:index>` that adhere to these guidelines for asynchronous event messaging will now be documented and made publicly available through the Architectural Decision Records (ADRs) in :doc:`Open edX Events ADRs <openedx-events:decisions/index>`. This includes decisions regarding the Event Bus, schema format, serialization, evolution, and design practices for event-driven architecture.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading this gave me additional ideas that you may like or not like.

  1. This reads like a small decision. I’m wondering if there could be a brief OEP that describes this decision named “Event Related Decision Records”, or “Event and Filter…” or “Hook, Event and Filter…” that details this change, and notes could point to this OEP?
  2. Maybe this won’t be the last time we choose a library repo for housing OEP-esque ADRs on a topic? We could consider updating OEP-19 with this as an option, or an OEP-19 sub ADR, and also list all the current cases as an index.

These are just ideas, and they could influence how we add the notes. That said, we could make these notes the first iteration.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I disagree with this - I think that's adding too much process that no one will ultimately end up reading/needing. I think this note in the OEP is enough. I ran this by Feanil and Kyle and they agree with me, as well.

oeps/architectural-decisions/oep-0041-arch-async-server-event-messaging.rst
**************
Change History
**************

2024-01-14: Added note about decisions related to Open edX Events being documented and made publicly available through the Architectural Decision Records (ADRs) in the repository.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There may be more places that warrant this change, but “the repository” is vague and by default might mean “this repository”, but it doesn’t.

Suggested change
2024-01-14: Added note about decisions related to Open edX Events being documented and made publicly available through the Architectural Decision Records (ADRs) in the repository.
2024-01-14: Added note about decisions related to Open edX Events being documented and made publicly available through the Architectural Decision Records (ADRs) in the openedx-events repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@robrap robrap robrap left review comments

@sarina sarina sarina approved these changes

Assignees
No one assigned
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Status: Needs Triage
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mariajgrimaldi @openedx-webhooks @sarina @robrap